Dokumentacja MAIL REST API 1.0

POST mailinglists/<domain>/<name>

Opis
Dodanie nowej listy pocztowej.
Sygnatura polecenia
  • Metoda żądania - POST
  • Ścieżka żądania (URL PATH) - parametry identyfikujące nową listę pocztową
  • Ciało żądania - wszystkie wymagane parametry modyfikujące dla listy pocztowej
  • Ciało odpowiedzi - wszystkie parametry opisujące nową listę pocztową
Parametry ścieżki:
(string) domain
wymagany Nazwa domeny w obrębie której ma znaleźć się nowa lista pocztowa.
przykładowa wartość: demo.kei.pl
(string) name
wymagany Nazwa dodawanej listy pocztowej.
przykładowa wartość: nowalista
wymagania składniowe:
  • - Tylko małe litery
  • - Pole nie może być puste
  • - Pole musi mieć co najmniej 2 znaki / znaków
  • - Pole może mieć najwyżej 32 znaki / znaków
  • - Dopuszczone po jednym wystąpieniu w ciągu symboli '/', '.' oraz '-'
Parametry modyfikujące:
description Dodatkowy opis listy, który będzie dodawany do adresu listy jako nadawcy (nagłówek From). Np. dla listy news@tld.pl można wpisać: Biuletyn Informacyjny.
wymagania składniowe:
  • - Pole może mieć najwyżej 255 znaki / znaków
(int) privacy_mode Wskazanie, kto może wysyłać wiadomości na listę

dowolny nadawca (lista otwarta)
tylko subskrybenci listy (lista zamknięta)
tylko moderatorzy listy (lista moderowana).
dopuszczalne wartości:
  • 0: lista otwarta
  • 2: lista zamknięta
  • 1: lista moderowana
(int) replyto_mode Wskazanie, jaki adres będzie się podpowiadał przy odpowiadaniu na wiadomość z listy (nagłówek Reply-To).
dopuszczalne wartości:
  • 0: odpowiedź na listę
  • 1: odpowiedź do nadawcy
  • 2: odpowiedź na podany adres e-mail
replyto_email Adres e-mail, jaki zawsze ma się podpowiadać przy odpowiadaniu na wiadomość z listy (nagłówek Reply-To).
wymagania składniowe:
  • - Tylko małe litery
replyto_catchall Przekierowanie wiadomości wysłanych na listę moderowaną przez jej subskrybentów na e-mail z pola Adres odpowiedzi.

Standardowo takie wiadomości są usuwane.
confirm_url Adres url dla linku potwierdzające zapis na listę lub wypis z listy pocztowej.
(int) autosubscribe_enabled Umożliwienie zapisu na listę dowolnemu użytkownikowi, który wyśle na jej adres wiadomość z tematem SUBSCRIBE.
subscribe_request_mail_body Szablon wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć zapisu na listę. Będzie ona zawierać link potwierdzający.
subscribe_request_mail_subject Temat wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć zapisu na listę.
wymagania składniowe:
  • - Pole może mieć najwyżej 255 znaki / znaków
unsubscribe_request_mail_body Szablon wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć wypisu z listy. Będzie ona zawierać link potwierdzający.
unsubscribe_request_mail_subject Szablon wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć wypisu z listy.
wymagania składniowe:
  • - Pole może mieć najwyżej 255 znaki / znaków
subscribe_mail_body Szablon wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie zapisu na listę.
subscribe_mail_subject Temat wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie zapisu na listę.
wymagania składniowe:
  • - Pole może mieć najwyżej 255 znaki / znaków
unsubscribe_mail_body Szablon wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie wypisu z listy.
unsubscribe_mail_subject Temat wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie wypisu z listy.
wymagania składniowe:
  • - Pole może mieć najwyżej 255 znaki / znaków
(array) accounts Lista subskrybentów listy pocztowej.
(array) moderators Lista moderatorów listy pocztowej.
Parametry odpowiedzi:
email Pełen adres pocztowy listy.
Przykładowe zapytanie:
POST https://as27.demo.kei.pl/v1/mailinglists/demo.kei.pl/nowalista,
 parametry:
{ "description":"Opis nowej listy pocztowej", "confirm_url":"1", "autosubscribe_enabled":1, }
Przykładowa odpowiedź:
{
    "name":"nowalista",
    "domain":"demo.kei.pl",
    "email":"nowalista@demo.kei.pl",
    "description":"Opis nowej listy pocztowej",
    "privacy_mode":0,
    "replyto_mode":0,
    "replyto_email":"",
    "replyto_catchall":0,
    "confirm_url":"1",
    "autosubscribe_enabled":1,
    "subscribe_request_mail_body":"Witam,Aby potwierdzić chęć zapisu adresu e-mail  
                                  na listę pocztową: kliknij na poniższy link:
                                  Ta wiadomość została wysłana z automatu, 
                                  proszę na nią nie odpowiadać.--Automat",
    "subscribe_request_mail_subject":"Potwierdź zgłoszenie zapisu na listę pocztową ",
    "unsubscribe_request_mail_body":"Witam,Aby potwierdzić chęć wypisu adresu e-mail  
                                    z listy pocztowej: kliknij na poniższy link:
                                    Ta wiadomość została wysłana z automatu, proszę 
                                    na nią nie odpowiadać.--Automat",
    "unsubscribe_request_mail_subject":"Potwierdzenie wypisu z listy pocztowej ",
    "subscribe_mail_body":"Witam,Adres e-mail  został dopisany do listy pocztowej: Ta 
                          wiadomość została wysłana z automatu, proszę na nią nie 
                          odpowiadać.--Automat",
    "subscribe_mail_subject":"Potwierdzenie zapisu na listę pocztową ",
    "unsubscribe_mail_body":"Witam,Adres e-mail  został wypisany z listy pocztowej: 
                            Ta wiadomość została wysłana z automatu, proszę na nią 
                            odpowiadać.--Automat",
    "unsubscribe_mail_subject":"Potwierdź zgłoszenie wypisu z listy pocztowej ",
    "accounts":[

    ],
    "moderators":[
        moderator@demo.kei.pl
    ]
}